Skip to content

Refresh documentation site#548

Merged
tturocy merged 32 commits intomasterfrom
fix/541
Sep 4, 2025
Merged

Refresh documentation site#548
tturocy merged 32 commits intomasterfrom
fix/541

Conversation

@edwardchalstrey1
Copy link
Copy Markdown
Member

@edwardchalstrey1 edwardchalstrey1 commented Aug 13, 2025

Changes

TODO:

  • Since Readthedocs currently defaults to "stable" (the most recent release) as oppose to "latest" (master branch) we need to either make a release after these docs changes, or change the behaviour such that "latest" is default This PR can be part of the imminent 16.4 release
  • Remove new logo in this PR and just keep old one

Reviewers

I have enabled docs preview builds for PRs on Readthe docs, you can view the build for this one here. The link is also present in the list of GH actions that ran below - for future updates to docs pages, the other GH actions should no longer run after this PR is merged, so it will be easy to find the Readthedocs PR preview link

@edwardchalstrey1 edwardchalstrey1 changed the title Fix/541 Refresh documentation site Aug 13, 2025
@edwardchalstrey1
Copy link
Copy Markdown
Member Author

Hi @tturocy @rahulsavani - I have made some updates to the Gambit documentation and website based on the idea of revamping the project/software's outward appearance as we discussed. This PR has the changes to the documentation, which are minimal in terms of content, whereas the website changes are much more significant.

Could I get you to do the following:

  1. In order to review the docs site changes in this PR, it would be great if we could set up previews via Readthedocs
    • I'll need one of you to add me there so I can do that.
    • I can probably also configure this to auto-build on push to master branch, because it looks like that didn't happen after my previous PR was merged
  2. Take a look at the logo design in [Documentation]: Create a modern logo for the Gambit documentation and website #544 and let me know your thoughts - It's included in this PR but can absolutely be switched out for something different!
  3. For reviewing the website changes, the easiest thing will probably look at this together next week as it's still a WIP in terms of content.

@edwardchalstrey1
Copy link
Copy Markdown
Member Author

edwardchalstrey1 commented Aug 21, 2025

With the old logo restored for the time being these changes should be good to merge and include in the upcoming release

@edwardchalstrey1 edwardchalstrey1 moved this from In progress to In review in Ed Chalstrey Gambit priorities Aug 22, 2025
@tturocy tturocy merged commit 6d84895 into master Sep 4, 2025
14 checks passed
@github-project-automation github-project-automation bot moved this from In review to Done in Ed Chalstrey Gambit priorities Sep 4, 2025
@tturocy tturocy deleted the fix/541 branch September 4, 2025 12:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Documentation]: Robust documentation builds [Documentation]: Update docs for installation, contributions

2 participants